IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/ifl/iflPixel.z/iflPixel

Text File | 2002-10-03 | 8.7 KB | 265 lines

iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))       IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))



NNNNAAAAMMMMEEEE
     iiiiffffllllPPPPiiiixxxxeeeellll - class for pixel abstraction

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     This is a base class and therefore has no inheritance.

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <ifl/iflPixel.h>

CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     This class abstracts the concept of a pixel of image data.  It contains
     the data type, the number of channels, and a list of component values.
     Pixels are used as arguments on an iflConverter constructor.

CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
     CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr

          iflPixel(iflDataType type=iflDataType(0), int nc=0, void* data=NULL)
          iflPixel(const iflPixel &pix)



     IIIInnnniiiittttiiiiaaaalllliiiizzzziiiinnnngggg

          void convert(const iflPixel& pix, iflDataType toType, int nc=0,
                         int* chanList=NULL)
          void operator=(const iflPixel &pix)
          void set(iflDataType type, int nc=0, void* data = NULL)


     MMMMeeeemmmmbbbbeeeerrrr aaaacccccccceeeessssssss

          void* getData() const
          iflDataType getDataType() const
          double getElem(int index) const
          int getNumChans() const
          void setElem(double elemValue, int index=0)
          double min() const
          double max() const


     CCCCoooonnnnvvvveeeennnniiiieeeennnncccceeee ooooppppeeeerrrraaaattttoooorrrrssss

          double operator[](int index) const
          int operator==(const iflPixel &p)
          int operator!=(const iflPixel &p)


FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     iiiiffffllllPPPPiiiixxxxeeeellll(((())))





                                                                        PPPPaaaaggggeeee 1111






iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))       IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))



          iflPixel(iflDataType type=iflDataType(0), int nc=0, void* data=NULL)
          iflPixel(const iflPixel &pix)


          The first constructor creates a pixel of data type, _t_y_p_e, with _n_c
          channels, and with the component values pointed to by _d_a_t_a.  The
          data values are copied into the iflPixel constructed.  The second
          constructor copies the attributes and data from the iflPixel
          specified by _p_i_x.  By default, a pixel of undefined type with no
          components is constructed.


     ccccoooonnnnvvvveeeerrrrtttt(((())))

          void convert(const iflPixel& pix, iflDataType toType, int nc=0,
                    int* chanList=NULL)


          This function copies the pixel specified by _p_i_x, converting to the
          new data type, _t_o_T_y_p_e.  A subset of the channels can be selected by
          listing the channels to copy from the source pixel in _c_h_a_n_L_i_s_t.  The
          length of the channel list is given by _n_c.

     ggggeeeettttDDDDaaaattttaaaa(((())))

          void* getData() const


          This function returns a pointer to the pixel component array.  This
          is identical in function to the ((((vvvvooooiiiidddd****)))) cast operation.

     ggggeeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee(((())))

          iflDataType getDataType() const


          This function returns the data type of the pixel.

     ggggeeeettttEEEElllleeeemmmm(((())))

          double getElem(int index) const


          This function returns the pixel component selected by _i_n_d_e_x.  The
          first component is at index zero.  This is identical in function to
          the [[[[]]]] subscript operation.









                                                                        PPPPaaaaggggeeee 2222






iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))       IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))



     ggggeeeettttNNNNuuuummmmCCCChhhhaaaannnnssss(((())))

          int getNumChans() const


          This function returns the number of channels in the pixel.

     mmmmiiiinnnn(((())))

          double min() const


          This function returns the minimum value of the pixel component
          array.

     mmmmaaaaxxxx(((())))

          double max() const


          This function returns the maximum value of the pixel component
          array.

     ooooppppeeeerrrraaaattttoooorrrr[[[[]]]]

          double operator[](int index) const


          This function returns the pixel component selected by _i_n_d_e_x.  The
          first component is at index zero.  This is identical in function to
          the ggggeeeettttEEEElllleeeemmmm(((()))) function.

     ooooppppeeeerrrraaaattttoooorrrr====(((())))

          void operator=(const iflPixel &pix)


          The assignment operator makes a copy of the right hand pixel, _p_i_x,
          in the left hand pixel.  The new copy retains the same data type,
          number of channels, and data values.

     ooooppppeeeerrrraaaattttoooorrrr========(((())))

          int operator==(const iflPixel &p)


          This operator returns TRUE if 'this' iflPixel is the same as _p (
          i.e. both have the same data type, number of channels and values );
          FALSE otherwise.






                                                                        PPPPaaaaggggeeee 3333






iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))       IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiiffffllllPPPPiiiixxxxeeeellll((((3333))))



     ooooppppeeeerrrraaaattttoooorrrr!!!!====(((())))

          int operator!=(const iflPixel &p)


          This operator returns TRUE if 'this' iflPixel is not the same as _p (
          i.e. they differ in the data type, number of channels or values );
          FALSE otherwise.

     sssseeeetttt(((())))

          void set(iflDataType type, int nc=0, void* data = NULL)


          This function initializes the pixel's data type to _t_y_p_e, sets the
          channel count to _n_c, and copies the component values from _d_a_t_a.

     sssseeeettttEEEElllleeeemmmm(((())))

          void setElem(double elemValue, int index=0)


          This function sets the pixel component selected by _i_n_d_e_x.  The first
          component is at index zero.

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     iflConverter




























                                                                        PPPPaaaaggggeeee 4444